Booking flow - Create reservation

POST 
/v1/restaurants/:id/reservations

Create a reservation for a given restaurant, with all details (meal date, party size and customer data).

Request

Path Parameters

id stringrequired

restaurant uuid that needs to be considered for filter

application/json

Body

mealDate daterequired

Reservation meal date

partySize integerrequired

Number of person attending to the reservation

offerUuid string
customerNote string

Possible values: <= 1000 characters

Special request field that the diner can enter text in while making the reservation

customer

object

email stringrequired

firstName stringrequired

lastName stringrequired

phone string

locale stringrequired

Possible values: Value must match regular expression ^([a-z]{2,3})(?:_([A-Z]{2}))?$

civility stringrequired

Possible values: [mr, mrs, ms, mr_and_mrs, mx, doctor, professor, counsel, ambassador, madam_ambassador, president, madam_president, magister, chef, lord, prince, princess, count, countess, duke, duchess, sir, lady, highness, baron, baroness, company]

optins

object

required

restaurantNewsletter booleanrequired

Optin the diner to the restaurant newsletter, when false is provided it will not unsusbscribe the diner

Responses

200

Successful

*/*

Schema

Schema

reservationUuid stringrequired

reservation uuid

restaurantUuid stringrequired

restaurant uuid

mealDate daterequired

Reservation meal date

partySize integerrequired

Number of person attending to the reservation

status stringrequired
Possible values: [RECORDED, CONFIRMED, CANCELED, NO_SHOW, REQUESTED, REFUSED]
• Reservation status
• Main statuses
  • - RECORDED: most frequent status, reservation is confirmed
  • - CANCELED: reservation has been canceled
  • - NO_SHOW: reservation has been flagged as no-show
• Secondary statuses
  • - REQUESTED: Reservation is waiting for a an action from the restaurant (on request booking or Waitlist) - not confirmed yet
  • - REFUSED: final state if a requested reservation has been declined by the restaurant
  • - REJECTED: general error on the reservation (should be rare)
offerUuid string
customerNote string

Possible values: <= 1000 characters

Special request field that the diner can enter while making the reservation

customer

object

required

customerUuid string

Customer UUID

email stringrequired

firstName stringrequired

lastName stringrequired

phone string

locale stringrequired

Possible values: Value must match regular expression ^([a-z]{2,3})(?:_([A-Z]{2}))?$

civility stringrequired

optins

object

required

restaurantNewsletter booleanrequired

Optin the diner to the restaurant newsletter, when false is provided it will not unsusbscribe the diner

Example (from schema)

{
  "reservationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "restaurantUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mealDate": "2022-01-03T18:10:17.269Z",
  "partySize": 2,
  "status": "RECORDED",
  "offerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerNote": "note by the customer",
  "customer": {
    "customerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "john@example.com",
    "firstName": "Doe",
    "lastName": "John",
    "phone": "+33612345678",
    "locale": "fr_FR",
    "civility": "mr",
    "optins": {
      "restaurantNewsletter": true
    }
  }
}

401

Unauthorized

*/*

Schema

Schema

data object
error string

Possible values: [Unauthorized]

statusCode number

Possible values: [401]

Example (from schema)

{
  "data": {},
  "error": "Unauthorized",
  "statusCode": 401
}

404

Not Found

*/*

Schema

Schema

data

object

code string

Possible values: [Restaurant not found]

error string

Possible values: [Not Found]

statusCode number

Possible values: [404]

Example (from schema)

{
  "data": {
    "code": "Restaurant not found"
  },
  "error": "Not Found",
  "statusCode": 404
}

409

Conflict

*/*

Schema

Schema

data

object

code string

Possible values: [DOUBLE_BOOKING]

error string

Possible values: [Conflict]

statusCode number

Possible values: [409]

Example (from schema)

{
  "data": {
    "code": "DOUBLE_BOOKING"
  },
  "error": "Conflict",
  "statusCode": 409
}

Loading...